/*
 * Copyright 2010 Google Inc.
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.google.websocket;

import java.io.IOException;
import java.util.Set;

/**
 * WebSocket framing API that supports fragmentation.
 */
public interface FragmentableWebSocket extends WebSocket {

  /**
   * Callbacks that can handle WebSocket fragments.
   */
  public interface FragmentableCallback extends Callback {

    /**
     * @param more
     * @param opcode
     * @param metadata
     * @param payload
     * @throws IOException 
     */
    void onFrameReceived(boolean more, int opcode, Set<ExtensionData> metadata,
        byte[] payload) throws IOException;
  }

  /**
   * Read one frame and process it via the supplied callback.
   * 
   * @param callback
   * @return true if there are more frames in this message
   * @throws IOException
   */
  boolean readOneFrame(FragmentableCallback callback) throws IOException;
}
